package item44;

/**
 * 第44条：为所有导出的API元素编写文档注释
 */
public class Main01 {

    public static void main(String[] args) {

        /**
         * @see java.util.List#get(int)
         * 方法注释
         * @see java.util.Map
         * 类注释
         */

        // 为了正确地编写API文档，必须在每个被导出的类、接口、构造器、方法和域声明之前增加一个文档注释。

        // 方法的文档注释应该简洁地描述出它和客户端之间的约定。

        // 再也没有必要在文档注释中使用HTML<code>或者<tt>标签了
        // javadoc{@code}标签更好，因为它避免了转义HTML元字符
        // <pre>{@code,然后在代码后面加上}</pre>
        // 同一个类或者接口中的两个成员或者构造器，不应该具有同样的概要描述。

        // 对于方法和构造器而言，概要描述应该是完整的动词短语（包含任何对象），它描述了该方法所执行的动作。

        // 对于类、接口和域，概要描述应该是一个名词短语，它描述了该类或者接口的实例，或者域本身所代表的事物。


        // 泛型或者方法编写文档时，确保在文档中说明所有的类型参数。

        // 为枚举类型编写文档时，要确保在文档中说明常量。

        // 为注解类型编写文档时，要确保在文档中说明所有成员。
    }

}
